home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / tools / czesc_2 / menulock / menulock.doc < prev    next >
Text File  |  1991-11-21  |  6KB  |  151 lines
  1.  
  2.                              MenuLock v1.01
  3.  
  4.                     © Copyright 1991 Jaba Development
  5.                        Written with DICE C v2.6 by
  6.                            Jan van den Baard
  7.  
  8.             Based on commodity code by Stefan Sticht (FISH 497)
  9.  
  10.  DISCAIMER
  11.  ---------------------------------------------------------------------------
  12.  The author is  NOT  responsible for  the  suitability or  accuracy of  this
  13.  documentation and/or the program(s)  it describes.  Any damage  directly or
  14.  indirectly caused by the use or  misuse of this  documentation  and/or  the
  15.  program(s) it describes is the sole responsibility of the user her/him self
  16.  ---------------------------------------------------------------------------
  17.  
  18.  COPYRIGHT
  19.  ---------------------------------------------------------------------------
  20.  MenuLock v1.01, © Copyright 1991  Jaba Development.  All  rights  reserved.
  21.  This program may be distributed  non-commercially only  providing that  the
  22.  executable,  source  code,  documentation  and   copyright  notices  remain
  23.  unchanged and are included with the distribution. This program is  FREEWARE
  24.  so no financial donation  is  necessary ( but welcome ). Send me a postcard
  25.  of your hometown if you use this program.
  26.  ---------------------------------------------------------------------------
  27.  
  28.  Have you ever browsed through the menus of a program and released  the menu
  29.  button over the wrong item? Or have you got an old mouse of which it's menu
  30.  button is broken or worn out?  If so this might  be the  program you  need.
  31.  MenuLock is a commodity which enables the user  to "lock" the menu strip of
  32.  a window at the touch of a few keys.  It's possible to start  MenuLock from
  33.  either the Shell or the Workbench. The following arguments are possible:
  34.  
  35.     PRIORITY=<pri>      - With  this  argument  it's  possible   to  set  the
  36.                           commodity it's priority in  the commodities  queue.
  37.                           Default : 0
  38.  
  39.     LOCK=<hotkey>       - This enables you to set your own hotkey (See below)
  40.                           to lock the menu strip.
  41.                           Default : rcommand down
  42.  
  43.     UNLOCK=<hotkey>     - This enables you to set your own hotkey (See below)
  44.                           to unlock the menu strip.
  45.                           Default : rcommand up
  46.  
  47.     QUIT=<hotkey>       - This enables you to set your own hotkey (See below)
  48.                           to quit the commodity.
  49.                           Default : lshift control q
  50.  
  51.  Here are some examples of how you can start MenuLock from the Shell:
  52.  
  53.     Run MenuLock LOCK="lalt l" UNLOCK="lalt u"
  54.     Run MenuLock QUIT "lcommand esc"
  55.  
  56.  NOTE: You have to "Run" or "RunBack"  MenuLock  when you  start it  from the
  57.        Shell. This is because DICE does  not have an  auto detach  "_main.c".
  58.        (Maybee I'll hack my own some day.....)
  59.  
  60.  You must specify the arguments via the tooltypes  array of the  program it's
  61.  icon when  it's started  from the  Workbench.  When you start  MenuLock from
  62.  the WBStartup drawer you must specify the DONOTWAIT tooltype.
  63.  
  64.  Input Description Strings (HotKeys):
  65.  
  66.  The Input Description String (HotKeys) has the following template:
  67.  
  68.     <qualifier> [qualifier] [...] <key>
  69.  
  70.     qualifier:  lshift          left shift key
  71.                 rshift          right shift key
  72.                 shift           either shift key
  73.                 capslock        capslock key
  74.                 caps            shift or capslock key
  75.                 control         control key
  76.                 lalt            left alt key
  77.                 ralt            right alt key
  78.                 alt             either alt key
  79.                 lcommand        left amiga key
  80.                 rcommand        right amiga key
  81.                 numericpad      key on numericpad
  82.                 rbutton         right mouse button
  83.                 midbutton       middle mouse button
  84.                 leftbutton      left mouse button
  85.                 newprefs        change in preferences
  86.                 diskremoved     disk ejected
  87.                 diskinserted    guess what.....
  88.  
  89.     key         f1 -> f10       function keys
  90.                 up              cursor up key
  91.                 down            cursor down key
  92.                 left            cursor left key
  93.                 right           cursor right key
  94.                 help            help key
  95.                 del             delete key
  96.                 return          return key
  97.                 enter           enter key
  98.                 backspace       backspace key
  99.                 esc             escape key
  100.                 space           space key
  101.                 comma           comma key
  102.                 upstroke        key released
  103.                 a -> z, 0 -> 9  normal ansi keys
  104.  
  105.  Choose your keys carefully when other commodities are running.
  106.  
  107.  Requirements:
  108.  
  109.  MenuLock needs atleast Kickstart 2.0 V36++ to run.
  110.  
  111.  Error return codes.
  112.  
  113.  MenuLock doesn't print information to the screen when something didn't work.
  114.  You can figure out what went wrong by checking  the return  code  with  this
  115.  list.
  116.  
  117.  20     MenuLock wasn't able to open the libraries it so desperatly needs.
  118.  21     MenuLock wasn't able to create a message port for the communication.
  119.  22     The broker could not be setup. This could mean that another commodity
  120.         is running which has the same name as MenuLock.
  121.  23     MenuLock  wasn't  able to  setup it's  HotKey filters.  This probably
  122.         means that you have fed MenuLock wierd HotKey strings.
  123.  24     There was an error detected if the commodity objects with CxObjError.
  124.  25     MenuLock wasn't able to setup the  InputEvent  structures  to emulate
  125.         the mouse menu button.
  126.  26     MenuLock wasn't able to setup it's Translate  objects.  This probably
  127.         means that you have fed MenuLock wierd HotKey strings.
  128.  27     You passed MenuLock wierd arguments in the Shell.
  129.  
  130.  History:
  131.  
  132.  V1.00 (15-Sep-1991) 5784 bytes.
  133.  
  134.     - Initial release
  135.  
  136.  V1.01 (22-Sep-1991) 5168 bytes.
  137.  
  138.     - MenuLock now  uses  the  Dos   routine  "ReadArgs()"  for  parsing  the
  139.       arguments when run from the Shell.
  140.  
  141.     - By-Passed the main from c.lib to trim some bytes off the executable.
  142.  
  143.  Bug reports, flames, etc. to me at the following address.
  144.  
  145.  Jan van den Baard
  146.  Bakkerstraat 176
  147.  3082 HE, Rotterdam
  148.  Holland
  149.  
  150.  Fido: 2:500/29 (Jan van.den.Baard)
  151.